<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>clock</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;clock
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="clock-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="clock-module.html">Module clock</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/python</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#coding: utf-8</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">'''Thin wrapper for pygame.Clock.</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">pygame</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"> </tt>
<a name="Clock"></a><div id="Clock-def"><a name="L9"></a><tt class="py-lineno"> 9</tt> <a class="py-toggle" href="#" id="Clock-toggle" onclick="return toggle('Clock');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="clock.Clock-class.html">Clock</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Clock-expanded"><a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line">  <tt class="py-docstring">"""</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">  This class grants objects information about the flow of time.</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">  It is mainly used to globally access the length of the last frame.</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">  It is a wrapper for C{pygame.time.Clock}.</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">  @type __frame_span: unsigned integer</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">  @cvar __frame_span: Length of the last game frame in miliseconds.</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-docstring">  @type __total_time: unsigned integer</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-docstring">  @cvar __total_time: Total time elapsed since game start in miliseconds.</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-docstring">  @type readonly: boolean</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-docstring">  @ivar readonly: Determines whether the instance may actually</tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt class="py-docstring">      alter the game clock. Defaults to True.</tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">  <tt id="link-0" class="py-name" targets="Variable clock.Clock.__frame_span=clock.Clock-class.html#__frame_span"><a title="clock.Clock.__frame_span" class="py-name" href="#" onclick="return doclink('link-0', '__frame_span', 'link-0');">__frame_span</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line">  <tt id="link-1" class="py-name" targets="Variable clock.Clock.__total_time=clock.Clock-class.html#__total_time"><a title="clock.Clock.__total_time" class="py-name" href="#" onclick="return doclink('link-1', '__total_time', 'link-1');">__total_time</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">  <tt id="link-2" class="py-name" targets="Variable clock.Clock.__clock=clock.Clock-class.html#__clock"><a title="clock.Clock.__clock" class="py-name" href="#" onclick="return doclink('link-2', '__clock', 'link-2');">__clock</a></tt> <tt class="py-op">=</tt> <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Variable spaceship.Projectile.time=spaceship.Projectile-class.html#time"><a title="spaceship.Projectile.time" class="py-name" href="#" onclick="return doclink('link-3', 'time', 'link-3');">time</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Class clock.Clock=clock.Clock-class.html"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-4', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"> </tt>
<a name="Clock.__init__"></a><div id="Clock.__init__-def"><a name="L30"></a><tt class="py-lineno">30</tt> <a class="py-toggle" href="#" id="Clock.__init__-toggle" onclick="return toggle('Clock.__init__');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="clock.Clock-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock.__init__-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Clock.__init__-expanded"><a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line"><tt class="py-docstring">    @type  readonly: boolean</tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line"><tt class="py-docstring">    @param readonly: Determines whether the instance may actually</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line"><tt class="py-docstring">        alter the game clock. Defaults to True.</tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">readonly</tt> <tt class="py-op">=</tt> <tt class="py-name">readonly</tt> </tt>
</div><a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line"> </tt>
<a name="Clock.tick"></a><div id="Clock.tick-def"><a name="L38"></a><tt class="py-lineno">38</tt> <a class="py-toggle" href="#" id="Clock.tick-toggle" onclick="return toggle('Clock.tick');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="clock.Clock-class.html#tick">tick</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fps</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock.tick-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Clock.tick-expanded"><a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line"><tt class="py-docstring">    Tick the game clock (if the instance allows for it).</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line"><tt class="py-docstring">    @type  fps: unsigned integer</tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line"><tt class="py-docstring">    @param fps: Describes the number to which the framerate is capped.</tt> </tt>
<a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">readonly</tt><tt class="py-op">:</tt> </tt>
<a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Instance not allowed to alter the game clock.'</tt><tt class="py-op">)</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line">      <tt id="link-5" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-5', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="clock.Clock.__frame_span" class="py-name" href="#" onclick="return doclink('link-6', '__frame_span', 'link-0');">__frame_span</a></tt> <tt class="py-op">=</tt> <tt id="link-7" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-7', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="clock.Clock.__clock" class="py-name" href="#" onclick="return doclink('link-8', '__clock', 'link-2');">__clock</a></tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method clock.Clock.tick()=clock.Clock-class.html#tick"><a title="clock.Clock.tick" class="py-name" href="#" onclick="return doclink('link-9', 'tick', 'link-9');">tick</a></tt><tt class="py-op">(</tt><tt class="py-name">fps</tt><tt class="py-op">)</tt> </tt>
<a name="L49"></a><tt class="py-lineno">49</tt>  <tt class="py-line">      <tt id="link-10" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-10', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="clock.Clock.__total_time" class="py-name" href="#" onclick="return doclink('link-11', '__total_time', 'link-1');">__total_time</a></tt> <tt class="py-op">+=</tt> <tt id="link-12" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-12', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="clock.Clock.__frame_span" class="py-name" href="#" onclick="return doclink('link-13', '__frame_span', 'link-0');">__frame_span</a></tt> </tt>
<a name="L50"></a><tt class="py-lineno">50</tt>  <tt class="py-line"> </tt>
<a name="L51"></a><tt class="py-lineno">51</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt id="link-14" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-14', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="clock.Clock.__frame_span" class="py-name" href="#" onclick="return doclink('link-15', '__frame_span', 'link-0');">__frame_span</a></tt> </tt>
</div><a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line"> </tt>
<a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line">  <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt>
<a name="Clock.get_time"></a><div id="Clock.get_time-def"><a name="L54"></a><tt class="py-lineno">54</tt> <a class="py-toggle" href="#" id="Clock.get_time-toggle" onclick="return toggle('Clock.get_time');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="clock.Clock-class.html#get_time">get_time</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock.get_time-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Clock.get_time-expanded"><a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-16" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-16', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="clock.Clock.__clock" class="py-name" href="#" onclick="return doclink('link-17', '__clock', 'link-2');">__clock</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Static Method clock.Clock.get_time()=clock.Clock-class.html#get_time"><a title="clock.Clock.get_time" class="py-name" href="#" onclick="return doclink('link-18', 'get_time', 'link-18');">get_time</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L56"></a><tt class="py-lineno">56</tt>  <tt class="py-line"> </tt>
<a name="L57"></a><tt class="py-lineno">57</tt>  <tt class="py-line">  <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt>
<a name="Clock.get_rawtime"></a><div id="Clock.get_rawtime-def"><a name="L58"></a><tt class="py-lineno">58</tt> <a class="py-toggle" href="#" id="Clock.get_rawtime-toggle" onclick="return toggle('Clock.get_rawtime');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="clock.Clock-class.html#get_rawtime">get_rawtime</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock.get_rawtime-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Clock.get_rawtime-expanded"><a name="L59"></a><tt class="py-lineno">59</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-19" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-19', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="clock.Clock.__clock" class="py-name" href="#" onclick="return doclink('link-20', '__clock', 'link-2');">__clock</a></tt><tt class="py-op">.</tt><tt id="link-21" class="py-name" targets="Static Method clock.Clock.get_rawtime()=clock.Clock-class.html#get_rawtime"><a title="clock.Clock.get_rawtime" class="py-name" href="#" onclick="return doclink('link-21', 'get_rawtime', 'link-21');">get_rawtime</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L60"></a><tt class="py-lineno">60</tt>  <tt class="py-line"> </tt>
<a name="L61"></a><tt class="py-lineno">61</tt>  <tt class="py-line">  <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt>
<a name="Clock.frame_span"></a><div id="Clock.frame_span-def"><a name="L62"></a><tt class="py-lineno">62</tt> <a class="py-toggle" href="#" id="Clock.frame_span-toggle" onclick="return toggle('Clock.frame_span');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="clock.Clock-class.html#frame_span">frame_span</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock.frame_span-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Clock.frame_span-expanded"><a name="L63"></a><tt class="py-lineno">63</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-22" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-22', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="clock.Clock.__frame_span" class="py-name" href="#" onclick="return doclink('link-23', '__frame_span', 'link-0');">__frame_span</a></tt> </tt>
</div><a name="L64"></a><tt class="py-lineno">64</tt>  <tt class="py-line"> </tt>
<a name="L65"></a><tt class="py-lineno">65</tt>  <tt class="py-line">  <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt>
<a name="Clock.get_fps"></a><div id="Clock.get_fps-def"><a name="L66"></a><tt class="py-lineno">66</tt> <a class="py-toggle" href="#" id="Clock.get_fps-toggle" onclick="return toggle('Clock.get_fps');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="clock.Clock-class.html#get_fps">get_fps</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Clock.get_fps-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Clock.get_fps-expanded"><a name="L67"></a><tt class="py-lineno">67</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-24" class="py-name"><a title="clock.Clock" class="py-name" href="#" onclick="return doclink('link-24', 'Clock', 'link-4');">Clock</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="clock.Clock.__clock" class="py-name" href="#" onclick="return doclink('link-25', '__clock', 'link-2');">__clock</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Static Method clock.Clock.get_fps()=clock.Clock-class.html#get_fps"><a title="clock.Clock.get_fps" class="py-name" href="#" onclick="return doclink('link-26', 'get_fps', 'link-26');">get_fps</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L68"></a><tt class="py-lineno">68</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Thu Jul 31 17:03:03 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
